home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr36 / vfx004wb.zip / VOTEFIX.DOC < prev    next >
Text File  |  1993-05-01  |  8KB  |  210 lines
  1. ─ VoteFix v0.04ß ───────────────────────────── Copyright Steve Mulligan 1993 ─
  2.  
  3. |Lines that start with a | have been added/changed from v0.03ß
  4.  
  5. |I could not write these docs without saying thanks to the gang in TEST305.
  6. |Bill, Peter, Brian, Paul, Elaine, Shayne, Malcolm, Marc, Steve, Rick -
  7. |Thanks a million!  I coulnd't have released this without your help.
  8.  
  9. NOTE:  This program is FREE to use.  There is NO price to this.  I don't
  10.        believe in charging for software.  If you plan to use this program
  11.        you SHOULD register with me by sending me NetMail telling my
  12. |      how/why you're using VoteFix.
  13.  
  14. WARNING:  This is a Beta Version.  It has tallied small elections on my
  15.       computer and my beta testers systems but yours may be diffrent
  16.       or you may not understand how to configure VoteFix right.  (Just
  17.       NetMail me if you're not sure)  It might not be too smart to
  18.       hold a major election for your local NC or RC.  It will only
  19.       handle about 512 candidates.  It will however allow for up to
  20.       2147483647 votes for each candiate.
  21.  
  22. |         If you plan to use it, I suggest only running one election at a
  23. |         time because that's all that works right now thanks to a bug in
  24. |         MKMSGSRC.
  25.  
  26. ─ Introduction ─
  27.  
  28.   VoteFix is a program for holding elections via FidoNet style technology.
  29. Elections can be held on nodes or points and users can send mail to VoteFix
  30. to vote in these elections.  VoteFix will manage the election, print reports
  31. as to who has voted so far and tally the results at the end of the election
  32. for you.
  33.  
  34. ─ The Files ─
  35.  
  36.   These files come with VoteFix:
  37.  
  38.   VOTEFIX.EXE   Executable.
  39.   VOTEFIX.OVR   Overlay File.
  40.   VOTEFIX.DOC   This documentaion.
  41.   VOTEFIX.CFG   The configuration.
  42.   VOTEFIX.USE   Short description of VoteFix.  Like AREAFIX.USE.
  43.   VOTEFIX.INF   Sample election information.
  44.   VOTEFIX.VOT   Sample valid vote list.
  45.   VOTEFIX.DEF   List of all DEF numbers.  Controls what VoteFix looks like.
  46. | VOTEFIX.LST   Sample registered voters list.
  47.  
  48.   Either you or VoteFix will make these:
  49.   
  50.   *.DEF         Definition files to change the way VoteFix appears.
  51.         If these are not found, VoteFix will create a set of
  52.         default DEF files.
  53.  
  54.   *.INF         Information about elections.  This is sent to people when
  55.         they request information about an election.  You should
  56.         also post it somewhere before the election so people know
  57.         what is happening.
  58.  
  59.   *.VOT         Valid vote list.  Every line contains a valid candidate in
  60.         the election.  If a file with this extension exists for an
  61.         election that you have defined, every ballot cast will be
  62.         compared against the candidates in this file.  This is good
  63.         to avoid spelling errors.
  64.  
  65. | *.LST         Registered voters list.  If a file with this extension exists
  66. |               for an election that you have defined, only people listed in
  67. |               this file will be able to vote.  The format of this file is
  68. |               simple.  Each line contains one entry.  The line looks like
  69. |               this :     <address> <username>
  70. |               
  71. |               eg: 1:163/307.30 Steve Mulligan
  72.  
  73. ─ Quick Setup ─
  74.  
  75.   Edit the VOTEFIX.CFG file.  Change the following options to your liking:
  76.  
  77.   Address
  78.   SystemName
  79.   SysopName
  80.   MsgBase
  81.   Subject
  82.   Tally
  83.  
  84. | Optionally, make your INF, VOT and LST files.  Then, make sure VoteFix gets
  85.   executed :
  86.  
  87.   a) Once a day if you scan the whole message base * RECOMENDED
  88.   b) Everytime you get mail if you scan from the lastread message
  89.   
  90. ─ Full Configuration ─
  91.  
  92.   Read the config file for full configuration information.  This section will
  93. be added in the final release.
  94.  
  95. ─ Usage ─
  96.  
  97.   Once you have configured all the needed files, you should install VoteFix
  98. somehow so it gets run :
  99.  
  100.   a) Once a day if you scan the whole message base * RECOMENDED
  101.   b) Everytime you get mail if you scan from the lastread message
  102.  
  103.   The -C command line options specifies the config file to use.
  104.   
  105.   eg: VOTEFIX -CMYFIX.CFG
  106.  
  107.       Will tell VoteFix to use the MYFIX.CFG file as the config file.
  108.  
  109.  
  110.   The -R command line will build a report of the results so far in every
  111.   election (or only the one specified after the -R), consisting only of users
  112.   passwords who have been received and post the report to the message bases
  113.   pointed to in the Tally config verb.
  114.  
  115.   eg: VOTEFIX -R
  116.  
  117.   Will build a report of all elections and post them to the bases pointed to
  118.   by the Tally config verb.
  119.  
  120.       VOTEFIX -RSOFTDRINK
  121.  
  122.   Will build a report of ONLY the SOFTDRINK election and post it to the bases
  123.   pointed to by the Tally config verb.
  124.  
  125.  
  126.   The -T command line will tally the results so far in every election (or only
  127.   the one specified after the -T) and post the report to the message bases
  128.   pointed to in the Tally config verb.
  129.  
  130.   eg: VOTEFIX -T
  131.   
  132.   Will tally results of all elections and post them to the bases pointed to
  133.   by the Tally config verb.
  134.  
  135.       VOTEFIX -TSOFTDRINK
  136.  
  137.   Will tally results of ONLY the SOFTDRINK election and post it to the bases
  138.   pointed to by the Tally config verb.
  139.  
  140.  
  141. | The -B command line loads the built in valid voters list builder.  It's a
  142. | very crude implementation.  It's not very good but it works okay.  If you
  143. | want to make a better one, please do.  The valid voters list builder first
  144. | asks you what election you want to build a valid voters list for.  It then
  145. | allows you to manually register voters or register voters by pulling them
  146. | right from the nodelist using wildcars.
  147.  
  148. ─ Holding An Election ─
  149.  
  150.   To hold an election, you should first setup VOTEFIX.CFG to recognize
  151. messages about that election.  Do this with the Subject verb.
  152.  
  153.   Then, you should make a .INF file with the same filename you used when you
  154. defined your election with the Subject verb.  To get an example of an .INF
  155. file, see VOTEFIX.INF (distributed with VoteFix).
  156.  
  157.   Then, you should make a .VOT file with the same filename you used when you
  158. defined your election with the Subject verb.  This file is a plain text file
  159. that has only the valid votes for the election.  It looks something like this
  160. (SOFTDRNK.INF) :
  161.  
  162. COKE
  163. PEPSI
  164. 7UP
  165. SPRITE
  166. ABSTAIN
  167.  
  168. | Once that is finished, you should make a .LST file with the same filename
  169. |you used when you defined your election with the Subject verb.  The file is
  170. |a plain text file containing the addresses of people allow to vote in the
  171. |election.  NOTE: Only make this file if you want to limit the people who
  172. |participate in your election.  A sample file looks like this:
  173.  
  174. |1:163/307.30 Steve Mulligan
  175. |1:163/307.4 Shayne Macaulay
  176. |1:163/307 Malcolm Campbell
  177.  
  178. ─ Beta Testers Wanted ─
  179.  
  180.   If you are in the 163 or 243 net or you don't mind polling long distance
  181. you are eligible to be a beta tester.  Simply NetMail Steve Mulligan at
  182. 1:163/307.30.  I will reply to you and tell you how to get the latest beta
  183. versions of software I make.
  184.  
  185. ─ On the Drawing Board ─
  186.  
  187.   This is a list of all the features my beta testers and I want to have added
  188. to VoteFix.  I'll get around to it in a while.  PLEASE ADD TO LIST AND FORWARD
  189. TO STEVE MULLIGAN 1:163/307.30.  If you want to become a Beta Tester, NetMail
  190. me and I'll send you beta releases.
  191.  
  192. NOTE : Anything you suggest at the moment WILL BE ADDED IMMEDIATLY.
  193.  
  194. |v1.00  · Ability to run vote in more than one election per message
  195. |       · Fix any bugs that are reported.
  196.  
  197. v1.10   · Report config verb.  Works much like Tally only used when your
  198.       do a -R command line.
  199.  
  200.     · Allow to change appearance of Large Tally Report and Password
  201.       report.
  202.  
  203. |       · Elections can be tallied automatically when they are over.
  204.  
  205. v1.20   · Add optional SoundEX comparisons.
  206.  
  207. If you have any additions to this list or any bugs, please let me know!
  208.  
  209. Steve Mulligan 1:163/307.30@fidonet.org
  210.